home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / PartMaker / ODF PartMaker Templates ReadMe next >
Encoding:
Text File  |  1996-09-08  |  4.4 KB  |  89 lines  |  [TEXT/ttxt]
  1. OpenDoc
  2. Development
  3. Framework
  4.                                                                                                                                                                                      
  5. ODF PartMaker Templates Read Me
  6. ODF Release 2                                                                                                                                                            
  7.  
  8. This document contains instructions for using PartMaker Pro to generate a new ODF project.
  9.  
  10.  
  11. Table of Contents
  12. -------------------------
  13. • What is PartMaker Pro
  14. • Updating Your 'nmap' Resources and Signature
  15. • Building your part
  16.  
  17.  
  18.  
  19. What is PartMaker Pro
  20.  
  21. The PartMaker Pro application along with the templates located in this 'Part Templates' folder allows you to quickly start a new part editor based on ODF.
  22.  
  23. We currently have seven templates: three for creating a non-embedding part based on the ODFHello, ODFForm, and ODFNothing examples, three for creating  embedding parts based on ODFContainer, ODFEmbed, and ODFTable, and one to create a Cyberdog savy part.
  24.  
  25. The PartMaker templates for ODF can be used with all the supported development environments: CodeWarrior for PPC and 68K, Symantec C++ for MPW (68K), and MrC. After choosing your development environment you can throw away unused development folders. The following table indicates which folders are necessary for each supported compiler:
  26.  
  27. Folder                        CW/PPC           CW/68K            Symantec68K            MrC    
  28.  
  29. CWPPCDebug            Yes              No                 No                No            
  30. CWPPCRelease          Yes              No                 No                No
  31. MCPPCDebug               No            No                 No                Yes
  32. MCPPCRelease             No               No                 No                Yes    
  33.  
  34. CW68KDebug               No               Yes                No                No    
  35. CW68KRelease             No               Yes                No                No    
  36. SC68KDebug               No               No                 Yes               No    
  37. SC68KRelease          No               No                 Yes               No    
  38.  
  39. We suggest that you create your new part folder in the ODFDev folder, since the project access paths are set up for that location.
  40.  
  41.  
  42.  
  43. Updating Your 'nmap' Resources and Signature
  44.  
  45. Whenever you create a new part, PartMaker creates a set of 'nmap' resources for your part. However, because the content of your part is likely to be different than the default content of the PartMaker part, you must change these resources to reflect your part's content. See the 'nmap', Icon, & Part Signature  document in the "Documentation:Development Notes:" folder for more information on how to do this.
  46.  
  47. The following table summarizes the creator, type, stationery type and part kind automatically generated by PartMaker for each template. 
  48.  
  49. Template                                                Creator                                Type                                                Stationery                            Part Kind                                               
  50. Container                     ODFJ                            DFPJ                            sFPJ                             <YourCompany>:Kind:<YourPartName>
  51. Embedder                         ODFR                            DFPR                            sFPR                             <YourCompany>:Kind:<YourPartName>
  52. Forms                                        ODFF                            DFPF                            sFPF                             <YourCompany>:Kind:<YourPartName>
  53. Hello                                     ODFH                            DFPH                            sFPH                                <YourCompany>:Kind:<YourPartName>
  54. Nothing                             ODFN                            DFPN                            sFPN                                <YourCompany>:Kind:<YourPartName>
  55. Tabler                                    ODFT                            DFPT                            sFPT                                <YourCompany>:Kind:<YourPartName>
  56. CyberStarter            PECS                            DFCS                            sFCS                                <YourCompany>:Kind:<YourPartName>
  57.  
  58.  
  59. You need to replace the creator, file type and stationery type in three files. 
  60.  
  61. 1) In the file Binding.k, change this line:
  62. #define MyContainerOSType 'DFPJ'    ==> 'WXYZ'  (Your File Type)
  63.  
  64. 2) In the file MacMake.bmk, change this line:
  65. __ComponentSignature = 'ODFJ' ==> 'ABCD'  (Your Creator)
  66.  
  67. 3) In the file "Part.r", change four resources:
  68. resource 'FREF' (129) {
  69.     'DFPJ',  ==> 'WXYZ'    (Your File Type)
  70. …
  71. resource 'FREF' (130) {
  72.     'sFPJ',  ==> 'sXYZ'    (Your Stationery File Type (File Type with 's' as first letter))
  73. …
  74. resource 'BNDL' (128) {
  75.     'ODFJ',  ==> 'ABCD'  (Your Creator)
  76. …
  77. data 'ODFJ' (0, "Owner resource")  ==> 'ABCD'  (Your Creator)
  78.  
  79. We encourage you to change these identifiers before building your part for the first time. 
  80.  
  81.  
  82.  
  83. Building Your Part
  84.  
  85. Please refer to the 'Getting Started' folder which contains documentation on how to build your part for each development environment.
  86.  
  87.  
  88. © 1993 - 1996 Apple Computer, Inc. All rights reserved.
  89. Apple, the Apple Logo, Macintosh, and OpenDoc are trademarks of Apple Computer, Inc., registered in the United States and other countries.